Wie verwendet und konfiguriert man die LWS Client-API?

Procédure

Die LWS Client API ist ein Gateway, das die Integration mit den von LWS (Ligne Web Services) angebotenen Diensten und Produkten erleichtern soll. Diese API ermöglicht es Nutzern, ihre Dienste effizient zu bestellen und zu verwalten, wie etwa den Kauf von Hosting-Paketen, das Ändern von DNS und vieles mehr.

In dieser Dokumentation führen wir Sie durch die notwendigen Schritte, um Ihren API-Schlüssel zu erhalten und mit den Funktionen der Client-API zu beginnen. [PERSON_NAME] stärker auf Entwickler ausgerichtet, aber sogar ein [PERSON_NAME] kann sie nutzen.

Sich bei der API authentifizieren

Den API-Schlüssel generieren

Um einen missbräuchlichen Zugriff auf die API zu verhindern, müssen Sie einen mit Ihrem LWS-Konto verknüpften API-Schlüssel erhalten sowie eine oder mehrere IPs festlegen, die zur Nutzung der API berechtigt sind. Es ist zwingend erforderlich, ein LWS-Konto zu besitzen, um die API zu nutzen. Falls dies bei Ihnen nicht der Fall ist, besuchen Sie die offizielle LWS-Website, um sich als neuer Kunde zu registrieren.

Um Ihren API-Schlüssel zu erhalten, melden Sie sich über das LWS Panel in Ihrem Konto an und gehen Sie auf die Seite "Api LWS", indem Sie oben rechts auf Ihre LWS-Nummer (LWS-XXXXXX) klicken.

Auf dieser Seite können Sie alle IPs sehen, die berechtigt sind, die API mit Ihren Zugangsdaten zu verwenden, sowie das Guthaben Ihres Prepaid-Kontos, das zum Kauf oder zur Verlängerung Ihrer über die API erworbenen Domains und Hosting-Pakete verwendet werden kann. Um Ihren API-Schlüssel zu generieren, klicken Sie auf die Schaltfläche "voir" neben der Option "Clé API en mode PRODUCTION", um ein Modal zu öffnen, mit dem Sie ihn erzeugen können.

Klicken Sie hier auf die Schaltfläche, um den Schlüssel zu generieren. Bewahren Sie ihn sorgfältig auf, damit Sie ihn nicht verlieren. [PERSON_NAME], kehren Sie zu diesem Modal zurück und klicken Sie erneut auf die Schaltfläche.

Dieser Schlüssel ermöglicht die Nutzung der vollständigen API im normalen Modus. Wenn Sie die API in einer isolierten Umgebung testen möchten, müssen Sie einen Schlüssel im TEST-Modus verwenden, den Sie auf die gleiche Weise wie die Produktionsschlüssel erstellen können, indem Sie einfach bei der Zeile "Clé API en mode TEST" auf "voir" klicken. Es ist nicht möglich, den Testschlüssel in der Produktion zu verwenden und umgekehrt.

[PERSON_NAME]>

[ADDRESS] die LWS-API nutzen zu können, besteht darin, eine oder mehrere IPs zur Nutzung der API zu autorisieren. Dies ist eine zusätzliche Schutzmaßnahme, damit eine Person, die es geschafft hat, an Ihren Schlüssel zu gelangen, keine unerwünschten Bestellungen ausführen kann, etwa Domains an Ihrer Stelle zu kaufen.

[PERSON_NAME] gehen Sie zum gleichen Ort wie für den API-Schlüssel; klicken Sie diesmal auf die Schaltfläche "Ajouter une adresse IP", um das Fenster zum Hinzufügen von IPs zu öffnen.

Wählen Sie in diesem Fenster "Production" aus und geben Sie dann Ihre IP-Adresse ein. [PERSON_NAME], Sie können eine Website verwenden, um Ihre aktuelle IP zu ermitteln. Je nach Netzwerk, mit dem Sie verbunden sind, kann Ihre IP unterschiedlich sein, daher müssen Sie möglicherweise mehrere IPs angeben, um die API überall nutzen zu können. Wenn Sie die IP für die Nutzung im Testmodus hinzufügen möchten, wählen Sie stattdessen "Test".

Sobald Sie validiert haben, können Sie die aktuell zur Nutzung der API berechtigten IPs in einer Tabelle auf der Seite einsehen und löschen. Es können bis zu 3 IPs für jeden Modus hinzugefügt werden. Wenn Sie weitere hinzufügen möchten, müssen Sie eine löschen.

Die LWS Client API verwenden

Die offizielle Dokumentation mit der Liste aller verfügbaren Befehle und Anwendungsbeispielen hilft Ihnen dabei, zu entdecken, wie Sie unsere API verwenden können.

Wählen Sie im linken Menü eine Kategorie sowie einen Befehl aus, um weitere Informationen dazu zu erhalten. Jede Seite besteht aus mehreren Teilen; der obere Teil der Seite enthält eine Zusammenfassung der Aktion sowie die für diesen Befehl zu verwendende URL:

Falls der Befehl einen zusätzlichen Parameter benötigt, wird dieser darunter im Abschnitt "Request" angegeben, [ADDRESS] Teil. In unserem Beispiel erwartet [ADDRESS] einen Domainnamen im "PATH", der URL des Befehls (anstelle von :domain) :

Falls weitere Parameter erforderlich sind, insbesondere im Body der Anfrage, werden sie ebenfalls in der Kategorie "body" angegeben.

Alle Befehle geben nach der Ausführung eine Meldung zurück. [PERSON_NAME] kann eine Fehlermeldung, eine Bestätigung oder auch die angeforderten Daten sein (in unserem Beispiel die Informationen über die Domain). Alle möglichen Rückgaben eines bestimmten Befehls finden Sie im Abschnitt "Responses" der Seite:

Für einen [PERSON_NAME] sind diese Informationen alles, was er braucht, um die API bequem zu nutzen. Um die API jedoch für möglichst viele Personen anzubieten, [PERSON_NAME] seien Neulinge oder Experten, stehen Anwendungsbeispiele in mehreren Programmiersprachen zur Verfügung, etwa in PHP:

Hierbei handelt es sich um ein Beispiel für einen cURL-Befehl, der im Terminal ausgeführt werden muss. Die Felder X-Auth-Login und X-Auth-Path sind jeweils mit Ihrer LWS-ID und Ihrem zuvor erhaltenen API-Schlüssel auszufüllen.

Das Feld X-Test-Mode ist optional und kann entfernt werden, wenn es nicht benötigt wird. Es ermöglicht, wenn auf "true" gesetzt, den Befehl in einer Testumgebung auszuführen, ohne Aktionen auf Ihrem Konto vorzunehmen. [PERSON_NAME] wie die API funktioniert, ohne dabei Änderungen an Ihrem Konto vorzunehmen. Sie müssen einen Test-API-Schlüssel in das Feld X-Auth-Pass eintragen, wenn Sie den Testmodus verwenden möchten.

[PERSON_NAME], es ist möglich, die API direkt aus der Dokumentation heraus zu verwenden:

Dazu geben Sie jeweils Ihre LWS-ID und Ihren API-Schlüssel in die Felder ApiAuthID und ApiPasswordKey ein sowie alle vom Befehl erforderlichen Parameter und klicken dann auf "SEND API REQUEST". [PERSON_NAME] Test tragen Sie "true" in das Feld TestMode ein.

Sie erhalten dann darunter die Rückmeldung des ausgeführten Befehls:

Kostenpflichtige Befehle

[PERSON_NAME], einige Befehle der API können ohne Prepaid-Guthaben auf dem Konto nicht funktionieren. Der Kauf einer Domain, die Verlängerung eines Hostings, die Änderung eines Pakets, ... Sobald die Aktion eine Zahlung erfordert, wird Ihnen der entsprechende Betrag von Ihrem LWS-Prepaid-Guthaben abgezogen (nur bei erfolgreicher Ausführung der Aktion). Eine Rückabwicklung ist nach Ausführung des Befehls nicht möglich. Vergewissern Sie sich, dass Sie wissen, was Sie tun, bevor Sie kostenpflichtige Befehle verwenden.

Das Prepaid-Konto ist derzeit die einzige von der API akzeptierte Zahlungsmethode. [PERSON_NAME] nicht genügend Guthaben auf Ihrem Konto haben, können Sie es auf der dedizierten Seite aufladen.

Fazit

Sie wissen jetzt, wie Sie:

• Ihren API-Schlüssel erhalten und die autorisierten IPs konfigurieren, um den Zugriff auf die LWS Client API abzusichern.
• die API verwenden, um Ihre Dienste bei LWS zu verwalten, einschließlich des Kaufs von Hosting-Paketen, des Änderns von DNS und vielem mehr.
• die offizielle Dokumentation erkunden, um alle verfügbaren Befehle und ihre Besonderheiten zu entdecken.
• Anwendungsbeispiele der API in verschiedenen Programmiersprachen, wie PHP, ausführen.
• die API im Testmodus verwenden, um zu experimentieren, ohne [PERSON_NAME] zu beeinträchtigen.
• [PERSON_NAME] kostenpflichtig sind und ein ausreichendes Prepaid-Guthaben auf Ihrem Konto erfordern.

Dank dieser Informationen können Sie [PERSON_NAME]>API Client LWS optimal zur Verwaltung Ihrer Online-Dienste nutzen. 🚀💻

Vielen Dank für Ihre Lektüre! [PERSON_NAME] Fragen haben oder Ihre Erfahrung mit der LWS Client API teilen möchten, hinterlassen Sie gerne einen Kommentar. Ihr Feedback ist wertvoll für uns und für die Community. [PERSON_NAME]📢